Tiny docs improvement
authorMatthias Clasen <mclasen@redhat.com>
Mon, 17 Aug 2009 13:16:12 +0000 (09:16 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 17 Aug 2009 17:46:30 +0000 (13:46 -0400)
Mention that gdk_xid_table_lookup may return  NULL. Bug 591432.

gdk/x11/gdkxid.c

index b4b46fe05f0bb8ab34480d00fff4490eb491662f..c53ee38355b46a576d2a30a4aa5966883dd3eea4 100644 (file)
@@ -77,14 +77,16 @@ _gdk_xid_table_remove (GdkDisplay *display,
     g_hash_table_remove (display_x11->xid_ht, &xid);
 }
 
-/** 
+/**
  * gdk_xid_table_lookup_for_display:
  * @display: the #GdkDisplay.
  * @xid: an X id.
  *
  * Returns the GDK object associated with the given X id.
  *
- * Returns: a GDK object associated with the given X id.
+ * Return value: the associated Gdk object, which may be a #GdkPixmap,
+ *     a #GdkWindow or a #GdkFont or %NULL if no object is associated
+ *     with the X id.
  *
  * Since: 2.2
  */
@@ -109,12 +111,14 @@ gdk_xid_table_lookup_for_display (GdkDisplay  *display,
 /**
  * gdk_xid_table_lookup:
  * @xid: an X id.
- * 
- * Returns the Gdk object associated with the given X id.
- * 
+ *
+ * Returns the Gdk object associated with the given X id for the default
+ * display.
+ *
  * Return value: the associated Gdk object, which may be a #GdkPixmap,
- * a #GdkWindow or a #GdkFont.
- **/
+ *     a #GdkWindow or a #GdkFont or %NULL if no object is associated
+ *     with the X id.
+ */
 gpointer
 gdk_xid_table_lookup (XID xid)
 {